<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
<meta name="generator" content="pdoc 0.10.0" />
<title>py3dtilers.GeojsonTiler.lineBuffer API documentation</title>
<meta name="description" content="" />
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/typography.min.css" integrity="sha256-7l/o7C8jubJiy74VsKTidCy1yBkRtiUGbVkYBylBqUg=" crossorigin>
<link rel="stylesheet preload" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/github.min.css" crossorigin>
<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/highlight.min.js" integrity="sha256-Uv3H6lx7dJmRfRvH8TH6kJD1TSK1aFcwgx+mdg3epi8=" crossorigin></script>
<script>window.addEventListener('DOMContentLoaded', () => hljs.initHighlighting())</script>
</head>
<body>
<main>
<article id="content">
<header>
<h1 class="title">Module <code>py3dtilers.GeojsonTiler.lineBuffer</code></h1>
</header>
<section id="section-intro">
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">import numpy as np
from shapely.geometry import LineString


class LineBuffer():
    &#34;&#34;&#34;
    A LineBuffer allows to create a polygon from a line by applying a buffer on this line.
    The buffer size depends on the offset of the LineBuffer instance.
    &#34;&#34;&#34;

    def __init__(self, buffer_size=1):
        self.offset = buffer_size / 2

    def line_intersect(self, l1_start, l1_end, l2_start, l2_end):
        &#34;&#34;&#34;
        https://stackoverflow.com/questions/64463369/intersection-of-two-infinite-lines-specified-by-points
        Find the intersection between 2 lines, each line is defined by 2 points
        &#34;&#34;&#34;
        p1_start = np.asarray(l1_start)
        p1_end = np.asarray(l1_end)
        p2_start = np.asarray(l2_start)
        p2_end = np.asarray(l2_end)

        p = p1_start
        r = (p1_end - p1_start)
        q = p2_start
        s = (p2_end - p2_start)

        t = np.cross(q - p, s) / (np.cross(r, s))
        i = p + t * r
        return i.tolist()

    def get_parallel_offset(self, start_point, end_point, offset=3):
        &#34;&#34;&#34;
        Return the parallel offsets (left and right) of a line
        :param start_point: the starting point of the line
        :param end_point: the ending point of the line
        :param offset: the distance between the line and its parallel offsets

        :return: left and right parallel offsets a list of points
        &#34;&#34;&#34;
        line = LineString([start_point, end_point])
        po_left = list(line.parallel_offset(offset, &#39;left&#39;, join_style=2, resolution=1).coords)
        po_right = list(line.parallel_offset(offset, &#39;right&#39;, join_style=2, resolution=1).coords)
        return po_left, po_right

    def buffer_line_string(self, coordinates):
        &#34;&#34;&#34;
        Take a line string as coordinates
        :param coordinates: a list of 3D points ([x, y, z])

        :return: a buffered polygon
        &#34;&#34;&#34;
        polygon = [None] * (len(coordinates) * 2)
        width_offset = self.offset

        po_1_left, po_1_right = self.get_parallel_offset(coordinates[0], coordinates[1], offset=width_offset)
        polygon[0] = [po_1_left[0][0], po_1_left[0][1], coordinates[0][2]]
        polygon[(len(coordinates) * 2) - 1] = [po_1_right[1][0], po_1_right[1][1], coordinates[0][2]]

        po_2_left, po_2_right = self.get_parallel_offset(coordinates[len(coordinates) - 2], coordinates[len(coordinates) - 1], offset=width_offset)
        polygon[len(coordinates) - 1] = [po_2_left[1][0], po_2_left[1][1], coordinates[len(coordinates) - 1][2]]
        polygon[len(coordinates)] = [po_2_right[0][0], po_2_right[0][1], coordinates[len(coordinates) - 1][2]]

        for i in range(0, len(coordinates) - 2):
            po_1_left, po_1_right = self.get_parallel_offset(coordinates[i], coordinates[i + 1], offset=width_offset)
            po_2_left, po_2_right = self.get_parallel_offset(coordinates[i + 1], coordinates[i + 2], offset=width_offset)

            intersection_left = self.line_intersect(po_1_left[0], po_1_left[1], po_2_left[0], po_2_left[1])
            intersection_right = self.line_intersect(po_1_right[0], po_1_right[1], po_2_right[0], po_2_right[1])
            polygon[i + 1] = [intersection_left[0], intersection_left[1], coordinates[i + 1][2]]
            polygon[len(polygon) - 2 - i] = [intersection_right[0], intersection_right[1], coordinates[i + 1][2]]

        return [coord for coord in polygon if not np.isnan(np.sum(coord))]</code></pre>
</details>
</section>
<section>
</section>
<section>
</section>
<section>
</section>
<section>
<h2 class="section-title" id="header-classes">Classes</h2>
<dl>
<dt id="py3dtilers.GeojsonTiler.lineBuffer.LineBuffer"><code class="flex name class">
<span>class <span class="ident">LineBuffer</span></span>
<span>(</span><span>buffer_size=1)</span>
</code></dt>
<dd>
<div class="desc"><p>A LineBuffer allows to create a polygon from a line by applying a buffer on this line.
The buffer size depends on the offset of the LineBuffer instance.</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">class LineBuffer():
    &#34;&#34;&#34;
    A LineBuffer allows to create a polygon from a line by applying a buffer on this line.
    The buffer size depends on the offset of the LineBuffer instance.
    &#34;&#34;&#34;

    def __init__(self, buffer_size=1):
        self.offset = buffer_size / 2

    def line_intersect(self, l1_start, l1_end, l2_start, l2_end):
        &#34;&#34;&#34;
        https://stackoverflow.com/questions/64463369/intersection-of-two-infinite-lines-specified-by-points
        Find the intersection between 2 lines, each line is defined by 2 points
        &#34;&#34;&#34;
        p1_start = np.asarray(l1_start)
        p1_end = np.asarray(l1_end)
        p2_start = np.asarray(l2_start)
        p2_end = np.asarray(l2_end)

        p = p1_start
        r = (p1_end - p1_start)
        q = p2_start
        s = (p2_end - p2_start)

        t = np.cross(q - p, s) / (np.cross(r, s))
        i = p + t * r
        return i.tolist()

    def get_parallel_offset(self, start_point, end_point, offset=3):
        &#34;&#34;&#34;
        Return the parallel offsets (left and right) of a line
        :param start_point: the starting point of the line
        :param end_point: the ending point of the line
        :param offset: the distance between the line and its parallel offsets

        :return: left and right parallel offsets a list of points
        &#34;&#34;&#34;
        line = LineString([start_point, end_point])
        po_left = list(line.parallel_offset(offset, &#39;left&#39;, join_style=2, resolution=1).coords)
        po_right = list(line.parallel_offset(offset, &#39;right&#39;, join_style=2, resolution=1).coords)
        return po_left, po_right

    def buffer_line_string(self, coordinates):
        &#34;&#34;&#34;
        Take a line string as coordinates
        :param coordinates: a list of 3D points ([x, y, z])

        :return: a buffered polygon
        &#34;&#34;&#34;
        polygon = [None] * (len(coordinates) * 2)
        width_offset = self.offset

        po_1_left, po_1_right = self.get_parallel_offset(coordinates[0], coordinates[1], offset=width_offset)
        polygon[0] = [po_1_left[0][0], po_1_left[0][1], coordinates[0][2]]
        polygon[(len(coordinates) * 2) - 1] = [po_1_right[1][0], po_1_right[1][1], coordinates[0][2]]

        po_2_left, po_2_right = self.get_parallel_offset(coordinates[len(coordinates) - 2], coordinates[len(coordinates) - 1], offset=width_offset)
        polygon[len(coordinates) - 1] = [po_2_left[1][0], po_2_left[1][1], coordinates[len(coordinates) - 1][2]]
        polygon[len(coordinates)] = [po_2_right[0][0], po_2_right[0][1], coordinates[len(coordinates) - 1][2]]

        for i in range(0, len(coordinates) - 2):
            po_1_left, po_1_right = self.get_parallel_offset(coordinates[i], coordinates[i + 1], offset=width_offset)
            po_2_left, po_2_right = self.get_parallel_offset(coordinates[i + 1], coordinates[i + 2], offset=width_offset)

            intersection_left = self.line_intersect(po_1_left[0], po_1_left[1], po_2_left[0], po_2_left[1])
            intersection_right = self.line_intersect(po_1_right[0], po_1_right[1], po_2_right[0], po_2_right[1])
            polygon[i + 1] = [intersection_left[0], intersection_left[1], coordinates[i + 1][2]]
            polygon[len(polygon) - 2 - i] = [intersection_right[0], intersection_right[1], coordinates[i + 1][2]]

        return [coord for coord in polygon if not np.isnan(np.sum(coord))]</code></pre>
</details>
<h3>Methods</h3>
<dl>
<dt id="py3dtilers.GeojsonTiler.lineBuffer.LineBuffer.buffer_line_string"><code class="name flex">
<span>def <span class="ident">buffer_line_string</span></span>(<span>self, coordinates)</span>
</code></dt>
<dd>
<div class="desc"><p>Take a line string as coordinates
:param coordinates: a list of 3D points ([x, y, z])</p>
<p>:return: a buffered polygon</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def buffer_line_string(self, coordinates):
    &#34;&#34;&#34;
    Take a line string as coordinates
    :param coordinates: a list of 3D points ([x, y, z])

    :return: a buffered polygon
    &#34;&#34;&#34;
    polygon = [None] * (len(coordinates) * 2)
    width_offset = self.offset

    po_1_left, po_1_right = self.get_parallel_offset(coordinates[0], coordinates[1], offset=width_offset)
    polygon[0] = [po_1_left[0][0], po_1_left[0][1], coordinates[0][2]]
    polygon[(len(coordinates) * 2) - 1] = [po_1_right[1][0], po_1_right[1][1], coordinates[0][2]]

    po_2_left, po_2_right = self.get_parallel_offset(coordinates[len(coordinates) - 2], coordinates[len(coordinates) - 1], offset=width_offset)
    polygon[len(coordinates) - 1] = [po_2_left[1][0], po_2_left[1][1], coordinates[len(coordinates) - 1][2]]
    polygon[len(coordinates)] = [po_2_right[0][0], po_2_right[0][1], coordinates[len(coordinates) - 1][2]]

    for i in range(0, len(coordinates) - 2):
        po_1_left, po_1_right = self.get_parallel_offset(coordinates[i], coordinates[i + 1], offset=width_offset)
        po_2_left, po_2_right = self.get_parallel_offset(coordinates[i + 1], coordinates[i + 2], offset=width_offset)

        intersection_left = self.line_intersect(po_1_left[0], po_1_left[1], po_2_left[0], po_2_left[1])
        intersection_right = self.line_intersect(po_1_right[0], po_1_right[1], po_2_right[0], po_2_right[1])
        polygon[i + 1] = [intersection_left[0], intersection_left[1], coordinates[i + 1][2]]
        polygon[len(polygon) - 2 - i] = [intersection_right[0], intersection_right[1], coordinates[i + 1][2]]

    return [coord for coord in polygon if not np.isnan(np.sum(coord))]</code></pre>
</details>
</dd>
<dt id="py3dtilers.GeojsonTiler.lineBuffer.LineBuffer.get_parallel_offset"><code class="name flex">
<span>def <span class="ident">get_parallel_offset</span></span>(<span>self, start_point, end_point, offset=3)</span>
</code></dt>
<dd>
<div class="desc"><p>Return the parallel offsets (left and right) of a line
:param start_point: the starting point of the line
:param end_point: the ending point of the line
:param offset: the distance between the line and its parallel offsets</p>
<p>:return: left and right parallel offsets a list of points</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def get_parallel_offset(self, start_point, end_point, offset=3):
    &#34;&#34;&#34;
    Return the parallel offsets (left and right) of a line
    :param start_point: the starting point of the line
    :param end_point: the ending point of the line
    :param offset: the distance between the line and its parallel offsets

    :return: left and right parallel offsets a list of points
    &#34;&#34;&#34;
    line = LineString([start_point, end_point])
    po_left = list(line.parallel_offset(offset, &#39;left&#39;, join_style=2, resolution=1).coords)
    po_right = list(line.parallel_offset(offset, &#39;right&#39;, join_style=2, resolution=1).coords)
    return po_left, po_right</code></pre>
</details>
</dd>
<dt id="py3dtilers.GeojsonTiler.lineBuffer.LineBuffer.line_intersect"><code class="name flex">
<span>def <span class="ident">line_intersect</span></span>(<span>self, l1_start, l1_end, l2_start, l2_end)</span>
</code></dt>
<dd>
<div class="desc"><p><a href="https://stackoverflow.com/questions/64463369/intersection-of-two-infinite-lines-specified-by-points">https://stackoverflow.com/questions/64463369/intersection-of-two-infinite-lines-specified-by-points</a>
Find the intersection between 2 lines, each line is defined by 2 points</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def line_intersect(self, l1_start, l1_end, l2_start, l2_end):
    &#34;&#34;&#34;
    https://stackoverflow.com/questions/64463369/intersection-of-two-infinite-lines-specified-by-points
    Find the intersection between 2 lines, each line is defined by 2 points
    &#34;&#34;&#34;
    p1_start = np.asarray(l1_start)
    p1_end = np.asarray(l1_end)
    p2_start = np.asarray(l2_start)
    p2_end = np.asarray(l2_end)

    p = p1_start
    r = (p1_end - p1_start)
    q = p2_start
    s = (p2_end - p2_start)

    t = np.cross(q - p, s) / (np.cross(r, s))
    i = p + t * r
    return i.tolist()</code></pre>
</details>
</dd>
</dl>
</dd>
</dl>
</section>
</article>
<nav id="sidebar">
<h1>Index</h1>
<div class="toc">
<ul></ul>
</div>
<ul id="index">
<li><h3>Super-module</h3>
<ul>
<li><code><a title="py3dtilers.GeojsonTiler" href="index.html">py3dtilers.GeojsonTiler</a></code></li>
</ul>
</li>
<li><h3><a href="#header-classes">Classes</a></h3>
<ul>
<li>
<h4><code><a title="py3dtilers.GeojsonTiler.lineBuffer.LineBuffer" href="#py3dtilers.GeojsonTiler.lineBuffer.LineBuffer">LineBuffer</a></code></h4>
<ul class="">
<li><code><a title="py3dtilers.GeojsonTiler.lineBuffer.LineBuffer.buffer_line_string" href="#py3dtilers.GeojsonTiler.lineBuffer.LineBuffer.buffer_line_string">buffer_line_string</a></code></li>
<li><code><a title="py3dtilers.GeojsonTiler.lineBuffer.LineBuffer.get_parallel_offset" href="#py3dtilers.GeojsonTiler.lineBuffer.LineBuffer.get_parallel_offset">get_parallel_offset</a></code></li>
<li><code><a title="py3dtilers.GeojsonTiler.lineBuffer.LineBuffer.line_intersect" href="#py3dtilers.GeojsonTiler.lineBuffer.LineBuffer.line_intersect">line_intersect</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</nav>
</main>
<footer id="footer">
<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.10.0</a>.</p>
</footer>
</body>
</html>